Returns a list of Location
objects specified by a warehouse id
path parameter.
The id
of the referenced Warehouse
.
Specify additional fields of the Location
object to be included in the response.
See the selecting fields page for more information.
Specify additional fields of the Lot
object to be included in the response. See the selecting fields page for more information.
Specify additional fields of the Product
or Packaging*
object to be included in the response. See the selecting fields page for more information.
Specify additional fields of the Rack
object to be included in the response. See the selecting fields page for more information.
Specify additional fields of the LocationType
object to be included in the response. See the selecting fields page for more information.
Specify additional fields of the Merchant
object to be included in the response. See the selecting fields page for more information.
Using the filtering syntax, you may filter the results using the following fields:
id
label
created_at
updated_at
qty_putaway
qty_unreserved
qty_reserved
The default sort order is descending by primary key (sort=-id
).
The following fields are available for sorting:
id
label
If specified as 1
, the meta.count
property of the response will be present and populated with the total count of items
matching the query before any paging is applied. This is not included by default to improve performance in some edge
cases and is not required to perform paging using the next
property of the response.
See paging parameters for more information.
0 <= x <= 1
A cursor for use in pagination which defines the last id
of the next page of results, non-inclusive.
See paging parameters for more information on paging.
A cursor for use in pagination which defines the starting id
of the next page of results.
See paging parameters for more information on paging.
A limit on the number of objects to be returned.
1 <= x <= 1000
100
A dictionary with a collection
property that contains a list of up to
limit
Location
objects matching the query.
The response is of type object
.